API Docs for:
Show:

Query<T> Class

Defined in: lib/query.js:6

オブジェクトの検索を行うモジュールです。

DataStore, User, Role, Fileクラスから呼び出し、それぞれのクラスメソッドとして利用します。 検索条件を設定するメソッドに続けてfetch/fetchAllをメソッドチェーンで実行して利用します。

Methods

Query<T>#allInArray

(
  • key
  • values
)
This

Defined in lib/query.js:198

指定したkeyの値が、配列values内のすべての値を含むオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • values Array

    比較する値

Returns:

This:

Query<T>#count

() This

Defined in lib/query.js:441

検索結果の配列と共に、検索結果の総件数を取得するよう設定します。 検索結果の配列は最大100件までしか取得しませんが、countは検索結果の総件数を表示します。 検索結果配列にcountプロパティとして付加されます。

Returns:

This:

Query<T>#equalTo

(
  • key
  • value
)
This

Defined in lib/query.js:45

指定したkeyの値がvalueと等しいオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • value Object

    比較する値

Returns:

This:

Query<T>#exists

(
  • key
  • exist
)
This

Defined in lib/query.js:143

指定したキーに値が存在するオブジェクトを検索します。 existがtrue(false)の場合、指定したkeyに値が存在する(しない)オブジェクトを検索します。 第二引数は省略可。省略時はtrueを指定した場合と同意となります。

Parameters:

  • key String

    値を比較するキー

  • exist Boolean

    true(false)を設定した場合、値が存在する（しない）オブジェクトを検索する。省略可能。

Returns:

This:

Query<T>#fetch

(
  • [callback]
)
Promise

Defined in lib/query.js:546

検索条件に合致するオブジェクトのうち、先頭の一つだけを取得します。

Parameters:

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

検索結果に合致したオブジェクト

Query<T>#fetchAll

(
  • [callback]
)
Promise>

Defined in lib/query.js:568

検索条件に合致するオブジェクトをすべて取得します。

Parameters:

  • [callback] Function optional

    コールバック関数

Returns:

Promise>:

検索結果に合致したオブジェクトの配列

Query<T>#fetchById

(
  • id
  • [callback]
)
Promise

Defined in lib/query.js:511

objectIdから一意のオブジェクトを取得します。

Parameters:

  • id String

    取得したいオブジェクトのobjectId

  • [callback] Function optional

    コールバック関数

Returns:

Promise:

オブジェクト

Query<T>#greaterThan

(
  • key
  • value
)
This

Defined in lib/query.js:93

指定したkeyの値がvalueより大きいオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • value Object

    比較する値

Returns:

This:

Query<T>#greaterThanOrEqualTo

(
  • key
  • value
)
This

Defined in lib/query.js:105

指定したkeyの値がvalue以上のオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • value Object

    比較する値

Returns:

This:

Query<T>#in

(
  • key
  • values
)
This

Defined in lib/query.js:117

指定したkeyの値が、配列values内のいずれかと等しいオブジェクトを検索します

Parameters:

  • key String

    値を比較するキー

  • values Array

    比較する値

Returns:

This:

Query<T>#inArray

(
  • key
  • values
)
This

Defined in lib/query.js:172

指定したkeyの値が、配列values内のいずれかと等しいオブジェクトを検索します

Parameters:

  • key String

    値を比較するキー

  • values Array

    比較する値

Returns:

This:

Query<T>#include

(
  • key
)
This

Defined in lib/query.js:427

指定したkeyに設定されているポインタの実態（オブジェクト）を検索し、返却値として返します。 複数回実行した場合、最後に設定したキーが反映されます。複数のキーを指定することはできません。

Parameters:

  • key String

    ポインタの中身を取得するキー

Returns:

This:

Query<T>#inQuery

(
  • key
  • subquery
)
This

Defined in lib/query.js:389

subqueriesの検索結果のうち、指定したkeyに設定されているポインタの実態（オブジェクト）を検索します。 objectはmobile backend に保存済みである必要がある。

Parameters:

  • key String

    ポインタを保存したキー

  • subquery Query

    検索条件

Returns:

This:

Query<T>#lessThan

(
  • key
  • value
)
This

Defined in lib/query.js:69

指定したkeyの値がvalueより小さいオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • value Object

    比較する値

Returns:

This:

Query<T>#lessThanOrEqualTo

(
  • key
  • value
)
This

Defined in lib/query.js:81

指定したkeyの値がvalue以下のオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • value Object

    比較する値

Returns:

This:

Query<T>#limit

(
  • limit
)
This

Defined in lib/query.js:479

検索結果の最大取得数を設定します。設定値は1から1000まで、デフォルト値は100です。

Parameters:

  • limit Number

    最大取得件数

Returns:

This:

Query<T>#near

(
  • key
  • location
)
This

Defined in lib/query.js:211

指定したキーの位置情報が指定した位置に近い順でオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • location NCMB.GeoPoint

    原点とする位置情報

Returns:

This:

Query<T>#notEqualTo

(
  • key
  • value
)
This

Defined in lib/query.js:57

指定したkeyの値がvalueと等しくないオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • value Object

    比較する値

Returns:

This:

Query<T>#notIn

(
  • key
  • values
)
This

Defined in lib/query.js:130

指定したkeyの値が、配列values内のいずれとも等しくないオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • values Array

    比較する値

Returns:

This:

Query<T>#notInArray

(
  • key
  • values
)
This

Defined in lib/query.js:185

指定したkeyの値が、配列values内のいずれとも等しくないオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • values Array

    比較する値

Returns:

This:

Query<T>#or

(
  • subqueries
)
This

Defined in lib/query.js:298

複数の検索条件subqueriesを設定し、その検索結果のいずれかに合致するオブジェクトを検索します 配列で複数の条件を一度に設定でき、複数回実行することで検索条件を追加できます。

Parameters:

  • subqueries Array> | Query

    検索条件

Returns:

This:

Query<T>#order

(
  • key
  • descending
)
This

Defined in lib/query.js:454

指定したkeyをソートして検索結果を取得するよう設定します。 （複数設定可能。先に指定したkeyが優先ソートされる。） フラグによって降順ソートも可能です。降順フラグはキーごとに設定できます。

Parameters:

  • key String

    ソートするキー

  • descending Object

    trueを指定した場合、降順でソートされる。省略可能。

Returns:

This:

Query<T>#regularExpressionTo

(
  • key
  • regex
)
This

Defined in lib/query.js:159

指定したkeyの値が正規表現regexに合致するオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • regex String

    検索する正規表現

Returns:

This:

Query<T>#relatedTo

(
  • object
  • key
)
This

Defined in lib/query.js:359

objectのkeyのプロパティに関連づけられているリレーションの実態（オブジェクト）を検索します。 objectはmobile backend に保存済みである必要があります。

Parameters:

  • object Object
  • key String

    オブジェクトが関連づけられているキー

Returns:

This:

Query<T>#select

(
  • key
  • subkey
  • subquery
)
This

Defined in lib/query.js:319

subqueriesの検索結果のうち、指定したsubkeyとkeyの値が一致するオブジェクトを検索します。

Parameters:

  • key String

    メインクエリのクラスで値を比較するキー

  • subkey String

    サブクエリの検索結果で値を比較するキー

  • subquery Query

    検索条件

Returns:

This:

Query<T>#skip

(
  • skip
)
This

Defined in lib/query.js:497

指定したskipの件数だけ頭から除いた検索結果を取得するよう設定します。

Parameters:

  • skip Number

    検索結果から除く件数

Returns:

This:

Query<T>#where

(
  • where
)
This

Defined in lib/query.js:27

クエリを直接記述して設定します。

Parameters:

  • where Object

    JSON形式のクエリオブジェクト

Returns:

This:

Query<T>#withinKilometers

(
  • key
  • location
  • maxDistance
)
This

Defined in lib/query.js:226

検索範囲内(Km)で、指定したキーの位置情報が指定した位置に近い順でオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • location NCMB.GeoPoint

    原点とする位置情報

  • maxDistance Number

    原点からの検索範囲(Km)

Returns:

This:

Query<T>#withinMiles

(
  • key
  • location
  • maxDistance
)
This

Defined in lib/query.js:244

検索範囲内(ml)で、指定したキーの位置情報が指定した位置に近い順でオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • location NCMB.GeoPoint

    原点とする位置情報

  • maxDistance Number

    原点からの検索範囲(ml)

Returns:

This:

Query<T>#withinRadians

(
  • key
  • location
  • maxDistance
)
This

Defined in lib/query.js:262

検索範囲内(rad)で、指定したキーの位置情報が指定した位置に近い順でオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • location NCMB.GeoPoint

    原点とする位置情報

  • maxDistance Number

    原点からの検索範囲(rad)

Returns:

This:

Query<T>#withinSquare

(
  • key
  • southWestVertex
  • northEastVertex
)
This

Defined in lib/query.js:280

指定したキーの位置情報で、左下（southWestVertex）と右上（northEastVertex）の2地点からなる矩形（長方形）で設定された検索範囲の内部にあるオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • southWestVertex NCMB.GeoPoint

    検索矩形の左下の頂点

  • northEastVertex NCMB.GeoPoint

    検索矩形の右下の頂点

Returns:

This: